Skip to content

feat: pin granting resources to top of API reference nav#1116

Open
sybohy wants to merge 1 commit into
feat/low-level-apis-sectionfrom
feat/api-reference-recommended-order
Open

feat: pin granting resources to top of API reference nav#1116
sybohy wants to merge 1 commit into
feat/low-level-apis-sectionfrom
feat/api-reference-recommended-order

Conversation

@sybohy
Copy link
Copy Markdown
Member

@sybohy sybohy commented Jun 5, 2026

Why

Part 3 of the Access Grants front-door refactor (stacked on #1115#1114). The API reference nav was purely alphabetical, so the legacy Access Codes and ACS resources sat at the very top while Access Grants was buried mid-list — the opposite of the recommendation.

What

A top-level rank in codegen/lib/layout/summary.ts:

  • Pinned first: Access Grants, Access Methods, Spaces, User Identities, Instant Keys
  • Alphabetical middle: everything else (unchanged)
  • Sunk last: Access Codes, Access Control Systems (ACS)

Generation stays fully automatic — no hand-edited generated files; npm run generate output is deterministic. No URLs change (pure reorder).

Validation

  • npm run generate → only docs/api-reference/SUMMARY.md changed
  • typecheck / lint / validate-paths / validate-links

Remaining (PR 4b, seam-connect)

Endpoint prose still says just "Creates a new Access Grant." and the access_codes/acs descriptions don't mention the recommendation — that text lives in seam-connect zod .describe() strings and flows through @seamapi/types. Separate PR there.

🤖 Generated with Claude Code

@sybohy sybohy requested review from a team as code owners June 5, 2026 23:20
@sybohy sybohy force-pushed the feat/low-level-apis-section branch from 31e78a9 to 19315bb Compare June 6, 2026 01:34
@sybohy sybohy force-pushed the feat/api-reference-recommended-order branch from 6fb0356 to 82be350 Compare June 6, 2026 01:35
@sybohy sybohy force-pushed the feat/low-level-apis-section branch from 19315bb to a754e08 Compare June 6, 2026 01:41
@sybohy sybohy force-pushed the feat/api-reference-recommended-order branch from 82be350 to f033228 Compare June 6, 2026 01:41
@sybohy sybohy force-pushed the feat/low-level-apis-section branch from 5006075 to 23b9aa2 Compare June 6, 2026 01:57
@sybohy sybohy force-pushed the feat/api-reference-recommended-order branch from d8f2ac1 to e7adb4b Compare June 6, 2026 01:57
@sybohy sybohy force-pushed the feat/low-level-apis-section branch from 23b9aa2 to 9a78cfb Compare June 6, 2026 02:24
@sybohy sybohy force-pushed the feat/api-reference-recommended-order branch 2 times, most recently from d9aae83 to 1771492 Compare June 6, 2026 02:39
@sybohy sybohy force-pushed the feat/low-level-apis-section branch from 133caf0 to 9aa6fc6 Compare June 6, 2026 02:57
@sybohy sybohy force-pushed the feat/api-reference-recommended-order branch from 1771492 to 374b646 Compare June 6, 2026 02:58
The API reference resource list was purely alphabetical, which put the
legacy Access Codes and ACS resources first and buried Access Grants.
Pin the recommended access-granting resources (access_grants,
access_methods, spaces, user_identities, instant_keys) to the top and
sink the low-level legacy granting resources (access_codes, acs) to
the bottom. Everything else stays alphabetical in between.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sybohy sybohy force-pushed the feat/api-reference-recommended-order branch from 374b646 to 9aa06a3 Compare June 6, 2026 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant